home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / timlok22.zip / TIMELOCK.DOC < prev    next >
Text File  |  1992-03-10  |  18KB  |  397 lines
  1.                              TIMELOCK
  2.            THE TIME MANAGEMENT SYSTEM FOR BBS DOORS AND PROGRAMS
  3.      
  4.      INTRODUCTION
  5.      ───────────────────────────────────────────────────────────────────
  6.           TimeLock  is  a  simple, yet  powerful  BBS,  Time  Management 
  7.           Program.   It enables Sysops to restrict access to BBS  Nodes, 
  8.           HUB  mail  doors, game  doors or, any other  BBS  door/utility 
  9.           program  during  specific times of the day  or  night.    Only 
  10.           designated  callers (or groups) can access a BBS node or  door 
  11.           program  during  a Sysop defined time slot  when  the  correct 
  12.           caller ID or password is provided.
  13.      
  14.      FOR NETMAIL HUBS
  15.           NetMail HUB Sysops!  You can now be sure that only  designated 
  16.           nodes  and hubs will access your BBS or Mail doors during  the 
  17.           Time Slots you assign.   No longer will you see your nodes and 
  18.           hubs  calling  outside  their designated  time  slots  bumping 
  19.           someone else out of their time slot.  Now you can truly  offer 
  20.           PROTECTED TIME SLOTS to your nodes and hubs.
  21.      
  22.      HOW TIMELOCK WORKS
  23.           TimeLock.EXE   can be placed in your board.bat, logon.bat  (if 
  24.           your  BBS  provides this feature) or in any  batch  file  that 
  25.           calls  a door or utility program.   When a caller attempts  to 
  26.           open a TimeLock Protected NODE, DOOR, or PROGRAM, TimeLock  is 
  27.           executed  first  and  determines whether the  caller  will  be 
  28.           allowed access based on the time slot assigned to them.  If in 
  29.           their  timeslot, TimeLock returns an error level of  zero.  If 
  30.           the caller is not in their timeslot, TimeLock returns an error 
  31.           level  of  255  (user  definable  error  level  in  Registered 
  32.           Version).  Based on these errorlevel you can allow the  caller 
  33.           to continue or return the to the board (or even log them off).
  34.      
  35.      SUMMARY OF TIMELOCK FEATURES
  36.      *   Allows  BBS  Sysops to restrict access to a BBS  NODE,  DOOR  or     
  37.          PROGRAM to designated callers and time periods.
  38.      
  39.      *   Written for PC Board, GAP, Wildcat and any other broad  capable     
  40.          of producing a DOOR.SYS file.  
  41.      
  42.      *   Prints schedule to Screen, File or Printer. Supports both  ASCII         
  43.          and ANSI Schedule Bulletin or News File (sysop definable).
  44.      
  45.      *   Allows for overlapping time slots permitting access to GROUPS of 
  46.          callers.
  47.      
  48.      *   Validate callers time slot using PASSWORD or CALLERID (username).
  49.      
  50.      *   Detailed Usage Log (* Registered Version).
  51.      
  52.      *   Multi-Node Operation (* Registered Version).
  53.      
  54.      *   User  Definable  Default  Time  Increments   when   establishing     
  55.          schedule database (* Registered Version).
  56.      
  57.      *   Sysop definable errorlevel  if caller is not in their  timeslot. 
  58.          (* Registered Version).
  59.      
  60.      *   Can retrieve PASSWORD or CALLER ID without user intervention. (* 
  61.          Registered Version).
  62.  
  63.  
  64.                                     ( -1- )
  65.  
  66.  
  67.  
  68.  
  69.      OVERVIEW OF TIMELOCK OPERATION
  70.      ───────────────────────────────────────────────────────────────────
  71.           The TimeLock system consists of two parts. TIMEDATA.EXE,  that 
  72.           allows  you to establish a schedule of callers and their  time 
  73.           slots.  And  TIMELOCK.EXE, that checks whether the  caller  is 
  74.           authorized to access the BBS or program during the time period 
  75.           called. 
  76.      
  77.      The TIMEDATA.EXE Program
  78.           TimeData   allows  you  to  create  a  database  containing  a 
  79.           starting  and  ending time (a Time Slot), a caller name or  ID 
  80.           (this   can be  a  HUB or  Node ID or  a users name), and    a  
  81.           password  as  shown   below.   Remember the "open" time  slots 
  82.           are  defined  by  those times for  which  no  TimeData  record 
  83.           covers and they are open to all users.
  84.           
  85.      Sample TimeData screen:
  86.      
  87.      | START  |  END  |   Caller ID                  |  Password      |
  88.      
  89.      20:00    20:15     HUBWOCKY                       XYZ123
  90.      20:15    20:30     THDOOR                         WEBSTER
  91.      20:30    21:00     HUBNY                          ALPHA
  92.           
  93.      The TIMELOCK.EXE Program
  94.           TimeLock  checks the database when the caller tries to open  a  
  95.           door  or  execute  a program protected by  TimeLock.   If  the 
  96.           password or callerid  provided (either thru entry or from  the 
  97.           system  file)  is valid  for  the   current  timeslot,    then  
  98.           TimeLock  returns an errorlevel of 0.  If it is not valid  for 
  99.           the current timeslot, TimeLock returns  errorlevel 255, or the  
  100.           exit  errorlevel  as  established  in  the configuration file.  
  101.           By testing for these errorlevels  in your  door batch   files, 
  102.           you  can  grant  or  deny access  to  the  program  or   door.  
  103.           (REGISTERED  USERS!  When  selecting  your  exit   errorlevel, 
  104.           remember  that  some  BBS  software  allows   activation    of  
  105.           various   features  when  an  errorlevel   is returned.    For 
  106.           example,  in GAP, an errorlevel of  62 (twit  key)  causes the 
  107.           carrier  to be dropped, disconnecting the  user and  recycling 
  108.           the board.)
  109.           
  110.      EXAMPLE: USING TIMELOCK FOR A HUB MAIL DOOR  
  111.      
  112.                 REM  HUBRIME.BAT
  113.                 echo off
  114.                 TimeLock TimeLock.CNF
  115.                 If errorlevel = 255 goto end
  116.                 F:
  117.                 cd F:\RIME\HUB
  118.                 rem run the HUB with the proper configuration file
  119.                 HUB CONFIG3.HUB REMOTE
  120.                 :end
  121.      
  122.           In  the  above example, when the Node or HUB calls  and  opens  
  123.           your Mail  Door,  TimeLock  either  requests  or  retrieves  a  
  124.           password or a caller ID.  If the password/caller id is correct 
  125.           for the current timeslot, an  errorlevel of 0 is  returned and 
  126.           the   batch  file allows the caller to open  the  mail   door.   
  127.           If it is incorrect, TimeLock   returns  an errorlevel of  255.  
  128.           The  caller  is  not permitted to open the mail  door  and  is 
  129.           returned to the BBS.
  130.                                     ( -2- )
  131.  
  132.  
  133.  
  134.  
  135.      INSTALLING & USING TIMELOCK:
  136.      ───────────────────────────────────────────────────────────────────
  137.                  
  138.      TIMLOKxx.ZIP contains the following files:
  139.                  
  140.           TIMELOCK.EXE - Program  that  requests  and  verifies  the
  141.                          password entered.
  142.           TIMELOCK.CNF - Sample configuration file for TimeLock.
  143.           TIMEDATA.EXE - Program  that  maintains the list  of  time
  144.                          slots and their passwords.
  145.           TIMEDATA.CNF - Sample configuration file for TimeData.
  146.           WHATS.NEW    - History of enhancements and corrections.
  147.           FILE_ID.DIZ  - Breif description file.
  148.           TIMELOCK.DOC - This file.
  149.           REGISTER.DOC - Registration form
  150.                  
  151.                  
  152.      To install TimeLock, follow the steps listed below.
  153.                  
  154.      STEP 1.   Make a directory for the TimeLock programs and files.   If 
  155.           you  are using the Shareware version, and running  multi-node, 
  156.           you  will  want  to  place  TimeLock  in  each  nodes  default 
  157.           directory.   Registered users  may  make one  area  regardless  
  158.           of the number of nodes.
  159.                  
  160.      STEP 2.   Make  configuration files.   You may use the sample  files 
  161.           (TIMELOCK.CNF   &  TIMEDATA.CNF)  for  this   purpose.    Each 
  162.           TimeLock  configuration file will contain seven (7)  lines  as 
  163.           follows.
  164.           
  165.                e:\node4            <== Path to system files
  166.                The Door            <== BBS Name
  167.                0                   <== 0=Gap/1=PC Board & Everything else
  168.                N                   <== Maintain Usage file? Y/N 
  169.                Y                   <== Get password from DOOR.SYS? Y/N
  170.                62                  <== Exist errorlevel for bad password
  171.                PASSWORD            <== Validate PASSWORD or CALLERID
  172.           
  173.      The TIMEDATA.CNF file will contain three (3) lines as follows.
  174.           
  175.                5                   <== Default Time Increment in Minutes
  176.                e:\node4\timedatg.  <== Path for ANSI bulletin/news file
  177.                e:\node4\timedat.   <== Path for ASCII bulletin/news file
  178.           
  179.      For more information about the configuration files, please view  the 
  180.      sample TIMELOCK.CNF and TIMEDATA.CNF files provided.
  181.           
  182.      STEP 3:    Establish  your time  slot database  using  the  TimeData 
  183.           program.  See page 4 for helpful hints on running this program.
  184.           
  185.      STEP 4:   Change  the batch files used to run the doors you wish  to 
  186.           protect  with  TimeLock.  (See  the  previous  example.)  Note  
  187.           that   if   you  are a registered user  you   may   pass   the   
  188.           configuration  file   name  that  you wish  to   use   on  the  
  189.           command   line.   If  this  configuration   name   is  omitted 
  190.           the TimeLock program  will  use the TIMELOCK.CNF file.)
  191.  
  192.  
  193.  
  194.  
  195.  
  196.                                     ( -3- )
  197.  
  198.  
  199.  
  200.  
  201.      USING TIMEDATA
  202.      ───────────────────────────────────────────────────────────────────
  203.      The TimeData program  allows you to establish the database  of  time 
  204.      slots   and which callerids or passwords will  activate them.   Note 
  205.      that   you  may enter the User Name, Hub Name, or Node  ID  in   the 
  206.      Caller  ID  field.
  207.           
  208.      Remember, if you are a  registered user and  you wish to   establish 
  209.      default time increments, then view and modify the TIMEDATA.CNF  file 
  210.      accordingly.   Also, you must establish your paths and filenames for 
  211.      printing your schedule to a bulletin or newsfile.
  212.           
  213.      The  TimeData  program is  very  straight  forward and easy to  use.  
  214.      However, a few helpful hints never hurt.
  215.           
  216.      1. To select a menu item you may use your arrow keys, or press   the 
  217.        first letter  of the item.  Note that  PAGE UP will function   as 
  218.        Previous, PAGE DOWN will function as Next and ESC will   function 
  219.        as Quit.   The ESC key  will also  abort the Adding &    Changing 
  220.        functions and return to the menu. 
  221.                  
  222.      2. When the  program requests  a Yes or No  response, the    default 
  223.        answer will appear in uppercase. For example, by pressing   Enter 
  224.        at the "Is this Correct? Y/n" prompt you would be selecting   the  
  225.        uppercase response, or "Y". 
  226.                  
  227.      3. Your arrow keys work in moving  around the screen and the   menu, 
  228.        but  do not  work well in editing.  So when you  are changing   a 
  229.        field, use your backspace key. 
  230.                  
  231.      4. Times  will be entered as hhmm, with no colon, it will be   added 
  232.        for  you. Make sure you pad your entries with zeros (i.e.   0500) 
  233.        and use a 24 hour clock. 
  234.                  
  235.      5. If  you established  a default  time slot  length, you will   not 
  236.        need  to enter an  Ending Time, just  press enter  and   TimeData 
  237.        will enter it for you.
  238.           
  239.      6. When  you  pRint to a file, remember that it will use  the   file 
  240.        names  that you established in the TIMEDATA.CNF file.
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                                     ( -4- )
  263.  
  264.  
  265.  
  266.  
  267.      LEGALITIES
  268.      ───────────────────────────────────────────────────────────────────
  269.           
  270.      DISTRIBUTION
  271.           TimeLock  (Tm) is a "shareware program" and is provided at  no 
  272.           charge to the user for evaluation.  Feel free to share it with 
  273.           your  friends,  but please do not give it away altered  or  as 
  274.           part  of  another  system.  The  essence  of  "user-supported" 
  275.           software  is to provide personal computer users  with  quality 
  276.           software without high prices, and yet to provide incentive for 
  277.           programmers to continue to develop new products.  If you  find 
  278.           this  program useful and you continue to use it after a  trial 
  279.           period  of  20 days, you must make a registration  payment  of 
  280.           $15.00  to Peiman & Associates Inc.  The  $15.00  registration 
  281.           fee  will license one copy for use on any one computer at  any 
  282.           one time.     
  283.      
  284.           Commercial or business users of this package must register and 
  285.           pay  for their copies of this package within 10 days of  first 
  286.           use or their license is withdrawn.  Site-License  arrangements 
  287.           may be made by contacting Peiman & Associates, Inc.. 
  288.      
  289.           You  are  encouraged to pass a copy of this package  along  to 
  290.           others for for evaluation.  Please encourage them to  register 
  291.           their copy if they find that they can use it.  
  292.                  
  293.        Peiman & Associates, Inc.             SUPPORT BBS
  294.        629 Peachwood Drive                   The DOOR BBS & Information Network
  295.        Altamonte Springs, FL. 32714          5-Nodes US Robotics DS/V.32bis/HST
  296.        (Neil Peiman, Compuserve 76630,2177)  407-682-3132                      
  297.                                        
  298.      
  299.      COPYRIGHT NOTICE AND TRADEMARKS
  300.           Distribute   this   program   intact!    This   software   and 
  301.           accompanying documentation are Copyright (c) 1991 by Peiman  & 
  302.           Associates, Inc..  All rights are reserved.  All PAI  Software  
  303.           products  are trademarks or registered trademarks of Peiman  & 
  304.           Associates,   Inc..   Other  brand  and  product   names   are 
  305.           trademarks  or  registered  trademarks  of  their   respective 
  306.           holders.
  307.                  
  308.      
  309.      DISCLAIMER OF WARRANTY
  310.           Users of this package must accept this disclaimer of warranty: 
  311.           "The TimeLock program is supplied as is.  Peiman &  Associates 
  312.           disclaims  all  warranties, expressed or  implied,  including, 
  313.           without  limitation, the warranties of merchantability and  of 
  314.           fitness  for any purpose. The author assumes no liability  for 
  315.           damages,  direct or consequential, which may result  from  the 
  316.           use of these software programs."
  317.                  
  318.      
  319.      REPORTING PROBLEMS
  320.           If  you encounter any problems with TimeLock which  you  think 
  321.           might  be a bug, please report it to us at the address  above, 
  322.           or contact us on the DOOR BBS.
  323.  
  324.  
  325.  
  326.  
  327.  
  328.                                     ( -5- )
  329.  
  330.  
  331.  
  332.  
  333.      DIFFERENCES BETWEEN THE SHAREWARE AND REGISTERED VERSIONS
  334.      ───────────────────────────────────────────────────────────────────
  335.           While the shareware version of TimeLock is not crippled in any 
  336.           way, registration enables additional features and functions.
  337.      
  338.           As a registered user, you will receive:
  339.                  
  340.               o  The right to continue using TimeLock
  341.               o  The latest version of TimeLock
  342.               o  Updates for 1 Year
  343.               o  Additional Program Features  
  344.               o  Technical support via The DOOR BBS, (407-682-3132)
  345.                  
  346.      
  347.           SHAREWARE                        REGISTERED VERSION
  348.        
  349.           Allows Sysops to restrict        Allows Sysops to restrict
  350.           caller access.                   caller access.
  351.      
  352.           Written for any BBS able         Written for any BBS able 
  353.           to produce a DOOR.SYS file.      to produce a DOOR.SYS file.
  354.      
  355.           Prints Schedule to Screen,       Prints Schedule to Screen,
  356.           Printer or File (ASCII and       Printer of File (ASCII and
  357.           ANSI news files).                ANSI news files).
  358.      
  359.           Allows overlapping time          Allows overlapping time 
  360.           slots.                           slots with warning.
  361.      
  362.           Validates callers time           Validates callers time 
  363.           slot using PASSWORD or           slot using PASSWORD or 
  364.           CALLERID (username).             CALLERID (username).   
  365.      
  366.           Multi-Node operations            Multi-Node operation 
  367.           from separate directories.       from one directory
  368.      
  369.           No Usage Log                     Detailed Usage Log 
  370.      
  371.           No Default Time Increments       User Definable Default Time 
  372.                                            Increments (for quick 
  373.                                            schedule entry.)
  374.      
  375.           Returns errorlevel of 255        Returns Sysop definable
  376.           if caller is not in their        errorlevel if caller is not
  377.           timeslot.                        in their timeslot. 
  378.      
  379.           Requires user entry for          Can retrieve PASSWORD or
  380.           PASSWORD or CALLER ID.           CALLER ID without user
  381.                                            intervention.
  382.      
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.                                     ( -6- )
  395.  
  396.  
  397.